<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2012 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: PersistentObjectEvent.html 689 2013-06-28 19:22:16Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.pobj;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.util.EventObject;<a name="line.10"></a>
<span class="sourceLineNo">011</span><a name="line.11"></a>
<span class="sourceLineNo">012</span>/**<a name="line.12"></a>
<span class="sourceLineNo">013</span> * Notification event emitted by a {@link PersistentObject} to listeners whenever there is an update to the root object.<a name="line.13"></a>
<span class="sourceLineNo">014</span> *<a name="line.14"></a>
<span class="sourceLineNo">015</span> * @param &lt;T&gt; type of the root persistent object<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>@SuppressWarnings("serial")<a name="line.17"></a>
<span class="sourceLineNo">018</span>public class PersistentObjectEvent&lt;T&gt; extends EventObject {<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>    private final long version;<a name="line.20"></a>
<span class="sourceLineNo">021</span>    private final T oldRoot;<a name="line.21"></a>
<span class="sourceLineNo">022</span>    private final T newRoot;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>    /**<a name="line.24"></a>
<span class="sourceLineNo">025</span>     * Constructor.<a name="line.25"></a>
<span class="sourceLineNo">026</span>     *<a name="line.26"></a>
<span class="sourceLineNo">027</span>     * @param persistentObject source of this event<a name="line.27"></a>
<span class="sourceLineNo">028</span>     * @param version the new persistent object version (i.e., the version of {@code newRoot})<a name="line.28"></a>
<span class="sourceLineNo">029</span>     * @param oldRoot previous root object; null if exiting from an empty start period<a name="line.29"></a>
<span class="sourceLineNo">030</span>     * @param newRoot updated root object; null if entering an empty stop period<a name="line.30"></a>
<span class="sourceLineNo">031</span>     */<a name="line.31"></a>
<span class="sourceLineNo">032</span>    public PersistentObjectEvent(PersistentObject&lt;T&gt; persistentObject, long version, T oldRoot, T newRoot) {<a name="line.32"></a>
<span class="sourceLineNo">033</span>        super(persistentObject);<a name="line.33"></a>
<span class="sourceLineNo">034</span>        this.version = version;<a name="line.34"></a>
<span class="sourceLineNo">035</span>        this.oldRoot = oldRoot;<a name="line.35"></a>
<span class="sourceLineNo">036</span>        this.newRoot = newRoot;<a name="line.36"></a>
<span class="sourceLineNo">037</span>    }<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span>    /**<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * Get the {@link PersistentObject} that originated this event.<a name="line.40"></a>
<span class="sourceLineNo">041</span>     */<a name="line.41"></a>
<span class="sourceLineNo">042</span>    @SuppressWarnings("unchecked")<a name="line.42"></a>
<span class="sourceLineNo">043</span>    public PersistentObject&lt;T&gt; getSource() {<a name="line.43"></a>
<span class="sourceLineNo">044</span>        return (PersistentObject&lt;T&gt;)super.getSource();<a name="line.44"></a>
<span class="sourceLineNo">045</span>    }<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span>    /**<a name="line.47"></a>
<span class="sourceLineNo">048</span>     * Get the version that this event is associated with. This will be the version of the {@linkplain #getNewRoot new root}.<a name="line.48"></a>
<span class="sourceLineNo">049</span>     *<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * &lt;p&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * The {@link PersistentObject} class always delivers notifications in order, so this<a name="line.51"></a>
<span class="sourceLineNo">052</span>     * number should always increase over time.<a name="line.52"></a>
<span class="sourceLineNo">053</span>     */<a name="line.53"></a>
<span class="sourceLineNo">054</span>    public long getVersion() {<a name="line.54"></a>
<span class="sourceLineNo">055</span>        return this.version;<a name="line.55"></a>
<span class="sourceLineNo">056</span>    }<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span>    /**<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * Get the old root prior to the update.<a name="line.59"></a>
<span class="sourceLineNo">060</span>     *<a name="line.60"></a>
<span class="sourceLineNo">061</span>     * &lt;p&gt;<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * The caller must not modify the returned object, as it is shared among all listeners.<a name="line.62"></a>
<span class="sourceLineNo">063</span>     *<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * @return the old root object; will be null if an empty start period has just ended<a name="line.64"></a>
<span class="sourceLineNo">065</span>     */<a name="line.65"></a>
<span class="sourceLineNo">066</span>    public T getOldRoot() {<a name="line.66"></a>
<span class="sourceLineNo">067</span>        return this.oldRoot;<a name="line.67"></a>
<span class="sourceLineNo">068</span>    }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span>    /**<a name="line.70"></a>
<span class="sourceLineNo">071</span>     * Get the new root after the update.<a name="line.71"></a>
<span class="sourceLineNo">072</span>     *<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * &lt;p&gt;<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * The caller must not modify the returned object, as it is shared among all listeners.<a name="line.74"></a>
<span class="sourceLineNo">075</span>     *<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * @return the new root object; will be null if an empty stop period has just started<a name="line.76"></a>
<span class="sourceLineNo">077</span>     */<a name="line.77"></a>
<span class="sourceLineNo">078</span>    public T getNewRoot() {<a name="line.78"></a>
<span class="sourceLineNo">079</span>        return this.newRoot;<a name="line.79"></a>
<span class="sourceLineNo">080</span>    }<a name="line.80"></a>
<span class="sourceLineNo">081</span>}<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>




























































</pre>
</div>
</body>
</html>
